home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / lib / include / cmd.h < prev    next >
Encoding:
C/C++ Source or Header  |  1989-07-21  |  2.6 KB  |  85 lines
  1. /*
  2.  * cmd.h --
  3.  *
  4.  *    This file declares things that are used to build, use and delete
  5.  *    command bindings tables.
  6.  *
  7.  * Copyright (C) 1986 Regents of the University of California
  8.  * Permission to use, copy, modify, and distribute this
  9.  * software and its documentation for any purpose and without
  10.  * fee is hereby granted, provided that the above copyright
  11.  * notice appear in all copies.  The University of California
  12.  * makes no representations about the suitability of this
  13.  * software for any purpose.  It is provided "as is" without
  14.  * express or implied warranty.
  15.  *
  16.  * $Header: /sprite/src/lib/cmd/RCS/cmd.h,v 1.3 89/06/15 21:07:46 ouster Exp $ SPRITE (Berkeley)
  17.  */
  18.  
  19. #ifndef _CMD
  20. #define _CMD
  21.  
  22. #include <stdio.h>
  23.  
  24. #ifndef _CLIENTDATA
  25. typedef int * ClientData;
  26. #define _CLIENTDATA
  27. #endif
  28.  
  29. typedef struct    Table    *Cmd_Table;
  30.  
  31. /*
  32.  * Return values from Cmd_Dispatch and Cmd_MapKey:
  33.  *
  34.  * CMD_OK -        Everything completed just fine.
  35.  * CMD_AMBIGUOUS -    The name of a command was ambiguous (it was a previx
  36.  *            of more than one command in the table).
  37.  * CMD_NOT_FOUND -    There was no command by that name in the table.
  38.  * CMD_PARTIAL -    In key-mapping, this keystroke is midway through
  39.  *            a sequence:  more keys will have to be typed before
  40.  *            a command mapping can be made.
  41.  * CMD_UNBOUND -    This keystroke sequence ending in this stroke isn't
  42.  *            bound to any command.
  43.  * CMD_BAD_ARGS -    A command had a bad argument (e.g. tried to use
  44.  *            selection but selection doesn't exist).
  45.  * CMD_ERROR -        An error of some sort occurred while executing a
  46.  *            command.
  47.  * CMD_VAR_LOOP -    Variable commands were nested to an outrageous level;
  48.  *            suggests that there's unbounded recursion.
  49.  */
  50.  
  51. #define CMD_OK            0
  52. #define CMD_AMBIGUOUS        1
  53. #define CMD_NOT_FOUND        2
  54. #define CMD_PARTIAL        3
  55. #define CMD_UNBOUND        4
  56. #define CMD_BAD_ARGS        5
  57. #define CMD_ERROR        6
  58. #define CMD_VAR_LOOP        7
  59.  
  60. /*
  61.  * Exported procedures.
  62.  */
  63. extern void        Cmd_BindingCreate();
  64. extern char *        Cmd_BindingGet();
  65. extern void        Cmd_BindingDelete();
  66. extern int        Cmd_EnumBindings();
  67. extern int        Cmd_MapKey();
  68. extern Cmd_Table    Cmd_TableCreate();
  69. extern void        Cmd_TableDelete();
  70. #ifdef NOTDEF
  71. /*
  72.  * Routines that were in John's mx.h but no longer seem to exist anywhere.
  73.  */
  74. extern int        Cmd_VarEnum();    /* not here */
  75. extern char *        Cmd_VarGet();    /* not here */
  76. extern void        Cmd_VarSet();    /* not here */
  77. extern void        Cmd_CommandCreate();    /* not here */
  78. extern void        Cmd_CommandDelete();    /* not here */
  79. extern int        Cmd_Dispatch();    /* not here */
  80. extern void        Cmd_Record();    /* not here */
  81. extern void        Cmd_StopRecording();    /* not here */
  82. #endif /* NOTDEF */
  83.  
  84. #endif _CMD
  85.